package org.bultreebank.extractor;

import java.util.Map;
import java.util.Set;

import org.w3c.dom.Document;

/**
 * Interface that contains method for content extraction of matching 
 * documents
 * @author Aneliya Ticheva
 *
 */

public interface Extractor
{
	/**
	 * Returns an XML document with the extracted relevant document fragments
	 * @param matchingDocIDs - an array of matching context identifiers
	 * @return
	 * @throws Exception
	 */
	Document getFormatedDocument(String[] matchingDocIDs) throws Exception;
	/**
	 * Returns a map which contains for each context, a map of the
	 * matching document identifiers and the relevant parts from them
	 * @param matchingDocIDs - an array of matching context identifiers
	 * @return
	 * @throws Exception
	 */
	Map<String, Map<String, Set<String>>> getFormattedResultList(String[] matchingDocIDs) throws Exception;
}
